feat(docs): Updated examples topic to use ECS L2 construct #1195

Doug-AWS · 2018-11-16T16:19:05Z

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license.

rix0rrr

This should ultimately also add a load balancer to make it do something useful I think.

rix0rrr · 2018-11-19T10:05:05Z

docs/src/examples.rst


-   Creating an App with Multiple Stacks
-   ====================================
+Creating an |ECS| Construct


I wouldn't call it "creating an ECS construct", that implies you're building a reusable thing.

Maybe "Writing an |ECS| CDK app" ?

Good point.

rix0rrr · 2018-11-19T10:06:08Z

docs/src/examples.rst

-   Implement the class **MyStack** in the *my-stack* sub-folder,
-   that extends the |stack-class| class
-   (this is the same code as shown in the :doc:`concepts` topic).
+* Automatic security group opening for load balancers


These are not sentences, maybe rephrase to a list of the form "it will open up ..." etc.

Yep. I wrote these based on some notes and forgot to re-visit.

rix0rrr · 2018-11-19T10:06:37Z

docs/src/examples.rst


-   import { Stack, StackProps } from '@aws-cdk/cdk'
+Step 1: Create the Directory and Initialze the |cdk|


Typo. Wouldn't capitalize Directory and Initialize here.

It is AWS docs style. We capitalize pretty much everything but articles (the, and, etc.).

rix0rrr · 2018-11-19T10:09:17Z

docs/src/examples.rst

-   import ec2 = require('@aws-cdk/aws-ec2');
-   import rds = require('@aws-cdk/aws-rds');
-   import cdk = require('@aws-cdk/cdk');
+There are two different ways of creating a serverless infrastructure with |ECS|:


I would write "two different ways of running your container tasks"

rix0rrr · 2018-11-19T10:09:46Z

docs/src/examples.rst

-       const vpc = new ec2.VpcNetwork(this, 'VPC');
+This example creates a Fargate service,
+which requires a VPC, a cluster, a task definition, and a security group.
+Later on we'll show you how to launch an EC2 service.


how to launch services on EC2 instances you manage yourself

rix0rrr · 2018-11-19T10:12:28Z

docs/src/examples.rst

-     }
-   }
+            // The task definition must have at least one container.
+            // Otherwise you cannot synthesize or deploy your app.


It sounds like a constraint if you put it like this. But also, if you don't add a container, WHAT are you even launching? Empty tasks that do nothing? That's not very useful.

So I wouldn't call attention to it in this way.

I rewrote the first comment line and removed the second comment line.

rix0rrr · 2018-11-19T10:12:50Z

docs/src/examples.rst

+            // The task definition must have at least one container.
+            // Otherwise you cannot synthesize or deploy your app.
+            taskDefinition.addContainer('MyContainer', {
+              image: ecs.ContainerImage.fromDockerHub('MyDockerImage')    // Required


Maybe launch amazon/amazon-ecs-sample, that's a container that at least does something.

rix0rrr · 2018-11-19T10:13:21Z

docs/src/examples.rst

+              taskDefinition: taskDefinition,  // Required
+              cluster: cluster,  // Required
+              desiredCount: 6,  // Default is 1
+              securityGroup: securityGroup,  // Required


No it's not.

rix0rrr · 2018-11-19T10:13:34Z

docs/src/examples.rst


-   const app = new cdk.App();
+            const securityGroup = new ec2.SecurityGroup(this, 'MySecurityGroup', {


This is actually not necessary.

rix0rrr · 2018-11-19T10:13:47Z

docs/src/examples.rst

+              cluster: cluster,  // Required
+              desiredCount: 6,  // Default is 1
+              securityGroup: securityGroup,  // Required
+              platformVersion: ecs.FargatePlatformVersion.Latest  // Default


Don't even call attention to this, just leave it out.

Doug-AWS · 2018-11-20T20:40:30Z

I've updated the list of benefits and am deploying the code now to make sure it works (50 minutes and counting):

28/30 | 11:50:59 | CREATE_COMPLETE | AWS::EC2::Route | MyVpc/PrivateSubnet2/DefaultRoute (MyVpcPrivateSubnet2DefaultRoute9CE96294)
28/30 Currently in progress: MyFargateService8825BC17

Doug-AWS · 2018-11-20T21:19:38Z

Strange. I nuked my deployment and the CFN stack. then started all over with a fresh project. The code deployed in about 3 1/2 minutes. The template grew from about 300 lines to almost 500.

rix0rrr · 2018-11-21T12:11:53Z

docs/src/examples.rst


-   import { Stack, StackProps } from '@aws-cdk/cdk'
+Step 1: Create the Directory and Initialze the |cdk|


rix0rrr · 2018-11-21T12:12:45Z

docs/src/examples.rst


-.. _dynamodb_example:
+        Update *my_ecs_construct.ts* in the *bin* directory to only contain the following code:


This will have gotten changed to lib/my_ecs_construct_stack.ts by the time this goes out.

Fixed the typo (sheesh); I just tested cdk init --language typescript in 0.18.1 and it still creates the TS file in the bin folder.

I know. The change is not released yet. That's why I wrote:

by the time this goes out.

I removed this part as the template has changed.

rix0rrr · 2018-11-21T12:15:31Z

docs/src/examples.rst

+            .. code-block:: ts
+
+                // Add capacity to it
+                cluster.addDefaultAutoScalingGroupCapacity({


Sorry, no. This is to add EC2 capacity to run Ec2Services on. You've been creating a FargateService so you don't need to do this.

You want what this section says:

https://github.com/awslabs/aws-cdk/blob/master/packages/%40aws-cdk/aws-ecs/README.md#task-autoscaling

I'll take it out for now.

rix0rrr · 2018-11-26T10:04:45Z

docs/src/examples.rst


-.. _dynamodb_example:
+        Update *my_ecs_construct.ts* in the *bin* directory to only contain the following code:


I know. The change is not released yet. That's why I wrote:

by the time this goes out.

rix0rrr · 2018-11-26T10:07:23Z

docs/src/examples.rst

-         readCapacity: 5,
-         writeCapacity: 5
-       });
+            const app = new cdk.App();


In fact these lines will also be gone.

These lines will live in a file in the bin directory, the other lines will live in a file in the lib directory.

Here's the new version of the app template: https://github.com/awslabs/aws-cdk/tree/master/packages/aws-cdk/lib/init-templates/app/typescript

rix0rrr · 2018-11-26T10:08:44Z

docs/src/examples.rst

+        |CFN| displays information about the dozens of steps that
+        it takes as it deploys your app.
+
+That's how easy it is to create a Fargate service to run a Docker image.


It's true. The example is not yet useful without a load balancer though, since this is a web service but you will be unable to hit the endpoints (because they'll be in a private VPC if I'm not mistaken).

Just sayin'.

Are you planning to make this section longer, or is it the plan to publish like this?

I'll add a load balancer and auto-scaling for tasks to the example. Once the new template is released, I'll fix the references:

my_ecs_construct.ts in the bin directory -> my_ecs_stack.ts in the lib directory

rix0rrr · 2018-12-06T15:12:21Z

docs/src/examples.rst

+            });
+
+            // Add capacity to it
+            cluster.addDefaultAutoScalingGroupCapacity({


Don't need capacity if you're starting a Fargate task

Right. I saw your comment to Paul in issue #1279.

Doug-AWS · 2018-12-06T16:20:59Z

I'm still blocked from confirming cdk deploy by issue #1279

rix0rrr · 2018-12-06T16:30:06Z

docs/src/examples.rst

@@ -65,7 +67,7 @@ gives you a leg up on using AWS services by providing the following benefits:
 * Automatically adds permissions for |ECR| if you use an image from |ECR|
  When you use an image from |ECR|, the |cdk| adds the correct permissions.

-* Convenient API for autoscaling
+* Automatic autoscaling


What does this mean? It's not automatic yet. I think we may have miscommunicated

Okay, so what should it say? Should I go back to:

Convenient API for autoscaling
The |cdk| supplies a method so you can autoscale instances when you use an |EC2| cluster;
this functionality is done automatically when you use an instance in a Fargate cluster.

Doug-AWS added 6 commits November 13, 2018 07:32

ECS example WIP

1caf425

ECS example WIP

8c8be92

Fixed TypeScript formatting

c6bc455

WIP; explained the two launch types

f342d3b

Fixed ECS example

29dfa0b

Removed lingering Java tab

5cb3d90

Doug-AWS added the 📚 documentation label Nov 16, 2018

rix0rrr reviewed Nov 19, 2018

View reviewed changes

Doug-AWS added 4 commits November 19, 2018 06:33

Update examples.rst

908f28a

WIP on ECS example

b5b3dd4

Update list of AWS service benefits; WIP

9105f97

Updated intro text for ECS example; WIP

6b36eb7

Doug-AWS added 3 commits November 20, 2018 13:34

Removed info about future content in examples

8e783ea

First cut at ECS example for re:Invent

675b8a8

Removed mentions of greeter service(s)

0f8713b

rix0rrr reviewed Nov 21, 2018

View reviewed changes

Update examples.rst

307b34a

rix0rrr reviewed Nov 26, 2018

View reviewed changes

Updated FargateService to LoadBalancedFargateService

aa359ac

Doug-AWS changed the title ~~feat(docs): Updated examples topic to use ECS L2 construct (first cut)~~ feat(docs): Updated examples topic to use ECS L2 construct Dec 3, 2018

rix0rrr reviewed Dec 6, 2018

View reviewed changes

Updated ECS example using CDK 0.19.0; removed autoscaling

d0e2aa2

rix0rrr reviewed Dec 6, 2018

View reviewed changes

Reverted autoscaling blurb

34275d9

rix0rrr approved these changes Dec 7, 2018

View reviewed changes

rix0rrr merged commit 9a7709e into master Dec 7, 2018

rix0rrr deleted the dougsch/replace-examples branch December 7, 2018 15:09

sumodgeorge mentioned this pull request Dec 2, 2023

[Snyk] Security upgrade nyc from 13.0.1 to 15.0.0 sumodgeorge/aws-cdk#19

Open


		import { Stack, StackProps } from '@aws-cdk/cdk'
		Step 1: Create the Directory and Initialze the \|cdk\|


		const app = new cdk.App();
		const securityGroup = new ec2.SecurityGroup(this, 'MySecurityGroup', {


		.. _dynamodb_example:
		Update my_ecs_construct.ts in the bin directory to only contain the following code:

feat(docs): Updated examples topic to use ECS L2 construct #1195

feat(docs): Updated examples topic to use ECS L2 construct #1195

Conversation

Doug-AWS commented Nov 16, 2018

rix0rrr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Doug-AWS commented Nov 20, 2018 • edited Loading

Doug-AWS commented Nov 20, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Doug-AWS commented Dec 6, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Doug-AWS commented Nov 20, 2018 •

edited

Loading